<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>配置 Quick Server - QuickServer Documents</title>
  

  <link rel="shortcut icon" href="../img/favicon.ico">

  
  <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>

  <link rel="stylesheet" href="../css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
  <link rel="stylesheet" href="../css/highlight.css">

  <script src="../js/jquery-2.1.1.min.js"></script>
  <script src="../js/modernizr-2.8.3.min.js"></script>
  <script type="text/javascript" src="../js/highlight.pack.js"></script>
  <script src="../js/theme.js"></script> 

  
</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
      <div class="wy-side-nav-search">
        <a href="../index.html" class="icon icon-home"> QuickServer Documents</a>
        
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
      <ul class="current">
    
        
            <li class="toctree-l1 ">
                <a class="" href="../index.html">Home</a>
                
            </li>
        

    
        
            <li class="toctree-l1 ">
                <a class="" href="../intro/index.html">介绍</a>
                
            </li>
        

    
        
            <li class="toctree-l1 ">
                <a class="" href="../install/index.html">安装 Quick Server</a>
                
            </li>
        

    
        
            <li class="toctree-l1 current">
                <a class="current" href="index.html">配置 Quick Server</a>
                
                    <ul>
                    
                        <li class="toctree-l3"><a href="#quick-server">Quick Server 详细配置</a></li>
                        
                            <li><a class="toctree-l4" href="#configlua">config.lua 文件</a></li>
                        
                    
                    </ul>
                
            </li>
        

    
        
            <li class="toctree-l1 ">
                <a class="" href="../admin/index.html">管理接口</a>
                
            </li>
        

    
        
            <li class="toctree-l1 ">
                <a class="" href="../changelog/index.html">Change Log</a>
                
            </li>
        

    
        
            <li class="toctree-l1 ">
                <a class="" href="../license/index.html">License</a>
                
            </li>
        

    
</ul>

      </div>
      &nbsp;
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="../index.html">QuickServer Documents</a>
      </nav>

      
      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="../index.html">Docs</a> &raquo;</li>
    
    <li>配置 Quick Server</li>
      <li class="wy-breadcrumbs-aside">
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main">
            <div class="section">
              <h1 id="quick-server">Quick Server 详细配置</h1>
<p>Quick Server 的基本配置都可以由 <code>config.lua</code> 完成。除此之外，对于高级用户，还可以直接修改 <code>nginx.conf</code> ， <code>redis.conf</code> 等配置文件来定制运行环境。</p>
<blockquote>
<p>在直接编辑 <code>nginx.conf</code> 或者 <code>redis.conf</code> 时，请自行保证修改后的配置符合 Quick Server 的运行要求，并且与 <code>config.lua</code> 中的设置保持兼容。</p>
</blockquote>
<h2 id="configlua">config.lua 文件</h2>
<p><code>config.lua</code> 文件本身是一个 Lua 的 table。分为应用程序设置和 Quick Server 系统设置两部分。</p>
<h3 id="_1">应用程序设置</h3>
<ul>
<li><code>appRootPath</code>: 配置用户 app 所在的位置（绝对路径）。例如：<code>appRootPath = "/home/apps/myapp"</code></li>
<li><code>numOfWorkers</code>: 指定启动多少个 Nginx Worker 进程。通常，这个数值应该和 CPU 内核数量相等，以获得最佳的性能表现。</li>
<li><code>appHttpMessageFormat</code>: 指定 HTTP 请求使用的消息格式，默认为 'json'。目前只支持 'json' 和 'text' 两种。</li>
<li><code>appSocketMessageFormat</code>: 指定 Socket 连接使用的消息格式，默认为 'json'。目前只支持 'json' 和 'text' 两种。</li>
<li><code>appJobMessageFormat</code>: 指定后台任务存储数据时使用的格式，默认为 'json'。目前只支持 'json' 和 'text' 两种。</li>
<li><code>appSessionExpiredTime</code>: 指定 Session 的过期时间，默认为 <code>600</code> 秒。</li>
</ul>
<h3 id="quick-server_1">Quick Server 系统设置</h3>
<ul>
<li><code>quickserverRootPath</code>: 指定 Quick Server 的安装目录，默认为 <code>_QUICK_SERVER_ROOT_</code>，通常不应修改。</li>
<li><code>port</code>: 指定 Quick Server 在哪一个端口接受请求，默认为 <code>8088</code>。</li>
<li><code>welcomeEnabled</code>: 指定是否启用 Quick Server 自带的欢迎界面，默认为 <code>true</code>。在生产服务器上可以将这个选项设置为 <code>false</code>，屏蔽掉欢迎界面。</li>
<li><code>adminEnabled</code>: 指定是否启用 Quick Server 内置的管理接口，默认为 <code>true</code>。欢迎界面中的服务器状态监控等功能需要依赖管理接口。</li>
<li><code>websocketsTimeout</code>: WebSocket 协议超时时间，默认值为 <code>60 * 1000</code>（60秒）。</li>
<li><code>websocketsMaxPayloadLen</code>: 客户端发往服务端的 WebSocket 消息的最大长度，默认值为 <code>16 * 1024</code>（16KB）。可以根据自己应用的情况调整这个设置。调整原则是满足需求的前提下，越小越好。</li>
<li><code>maxSubscribeRetryCount</code>: 指定订阅广播频道最大尝试次数，默认为 <code>10</code> 次。</li>
<li><code>redis.*</code>: 指定 Quick Server 内部使用的 Redis 数据库的连接方式和协议超时时间。</li>
<li><code>beanstalkd.*</code>: 指定 Quick Server 内部使用的 Beanstalkd 任务队列的连接方式。</li>
<li><code>beanstalkd.jobTube</code>: 指定 Quick Server 内部使用什么“桶”来存储后台任务。</li>
<li><code>monitor.process</code>: 指定管理接口要监控的进程。</li>
<li><code>monitor.interval</code>: 指定监控数据刷新的频率。</li>
</ul>
            </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="../admin/index.html" class="btn btn-neutral float-right" title="管理接口"/>Next <span class="icon icon-circle-arrow-right"></span></a>
      
      
        <a href="../install/index.html" class="btn btn-neutral" title="安装 Quick Server"><span class="icon icon-circle-arrow-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
    <!-- Copyright etc -->
    </p>
  </div>

  Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
	  
        </div>
      </div>

    </section>

  </div>

<div class="rst-versions" role="note" style="cursor: pointer">
    <span class="rst-current-version" data-toggle="rst-current-version">
        
      <span><a href="../install/index.html" style="color: #fcfcfc;">&laquo; Previous</a></span>
      <span style="margin-left: 15px"><a href="../admin/index.html" style="color: #fcfcfc">Next &raquo;</a></span>
    </span>
</div>

<!--
MkDocs version  : 0.12.1
Docs Build Date : 2015-04-19 02:55:50.886747
-->
</body>
</html>